TE Product Data API
Get Products
POST /products
Retrieve products that match a combination of filters like product categories (1 or more) and last change date of the part. Either one of these filters can be specified by itself or they can be combined together. If no filters are provided, then all products are retrieved.
If last change date (filters.lastChangeDate) is included, products that have been added or updated after the given date are returned.
If product categories are included (filters.categories), products that belong to the specified product categories or to a subcategory of the passed product categories are retrieved. Product category names can be obtained by calling the "Get Product Categories" (/product_categories) API endpoint. Product categories may be specified at any level in the hierarchy tree and across different hierarchies. The maximum number of product categories that can be passed in a single request is 100.
A product that is cross listed in different hierarchies is only included once in the results; the alternate cross listed hierarchy tree is included in the product data (products.alternateCategoryTrees).
Only Active, categorized, and published products are included in the results of this API endpoint. Other lifecycle statuses such as Obsolete or Superceded are not included in the results.
To keep responses to a manageable size, the maximum number of products returned in a single response is 100. A pagination mechanism is provided to allow retrieving all the matching products in subsequent requests. The totalMatchingProducts property in the response (results.pagination.totalMatchingProducts) is the total count of products that match the input criteria and currentProductCount is the count of products returned in the current response. If the totalMatchingProducts count is greater than the currentProductCount, then you can retrieve the additional matching products by changing the offset property in the "pagination" element on each subsequent request. The nextOffset property in the response gives you a hint of what offset value to specify on the next request. For example, offset 0 returns the first product up to the limit; offset 100 returns the hundredth matching product up to the limit, etc.
Default sort order: categoryTree, followed by TCPN
Content Type
application/json
Request
| Property | Description | Required? |
|---|---|---|
| filters.lastChangeDate | Retrieve products that have been added or updated since this date. Date format is YYYY-MM-DD | |
| filters.categories | A list of 1 or more Product categories. The product category name must match exactly as provided in the "Get Product Categories" endpoint. Each Product category is provided as a String and multiple categories provided as a JSON array structure. | |
| responseFormat | The format of the response. Valid values are "json" and "xml". Default value is "json". | No |
| pagination.offset | The offset within the results to begin returning Products. This value is zero-based...so offset 0 is Product #1, offset 50 is Product #51. Default value is 0. To retrieving all matching products, make additional requests by increasing the value of offset with each new request: [new offset value] = [prior offset] + [limit]. Keep the limit and the sort parameters set to same values on each subsequent request. | |
| pagination.limit | The number of matching Products to return in a single response. This is an upper limit. If there are fewer matching Products, then number of Products returned will be less than the limit value. Maximum allowed value is 100. Default value is 100. | |
| sort.field | The field name on which to sort the results. The following fields can be specified as a sort field. Only 1 field can be specified in a request.
| No |
| sort.order | The order in which to sort on the field. Valid values are: "asc" (ascending order) and "desc" (descending order). | No |
| language | The language used for the text values in the response. Currently, only English is supported...so this property is for future use. Default value is "en" (English). | No |
Response
| Property | Description |
|---|---|
| pagination.currentOffset | The offfset value used for the current request. It matches the value passed in the requestpagination.offset property. |
| pagination.nextOffset | The suggested offset value to use on the next request to continue retrieving the additional matching products. [nextOffet] = [currentOffset] + [pagination.limit in request] |
| pagination.maxAllowedlimit | The maximum value allow for the pagination.limit value in the request. |
| pagination.totalMatchingProducts | The total number of products that matched the input criteria passed in the request. This can be used to help determine how many additional requests will be need to retrieve all the matching products. |
| pagination.currentProductCount | The number of products returned in the current response output. |
| exceptionAlerts.productCategoriesNotFound | A list of product categories that did not match. Only pertains if product categories are sent in the request. |
| products | See the Products Model Response page for detailed definitions of the product fields that are returned. |